relay5

---

Relay 5 Click

Relay 5 Click demo application is developed using the NECTO Studio, ensuring compatibility with mikroSDK's open-source libraries and tools. Designed for plug-and-play implementation and testing, the demo is fully compatible with all development, starter, and mikromedia boards featuring a mikroBUS™ socket.

---

Click Library

• Author : Stefan Filipovic
• Date : Mar 2023.
• Type : I2C type

Software Support

Example Description

This example demonstrates the use of Relay 5 Click board by toggling the relays state.

Example Libraries

• MikroSDK.Board
• MikroSDK.Log
• Click.Relay5

Example Key Functions

• relay5_cfg_setup Config Object Initialization function.

  void relay5_cfg_setup ( relay5_cfg_t *cfg );

• relay5_init Initialization function.

  err_t relay5_init ( relay5_t *ctx, relay5_cfg_t *cfg );

• relay5_default_cfg Click Default Configuration function.

  err_t relay5_default_cfg ( relay5_t *ctx );

• relay5_set_relay1_open This function sets the relay 1 to normally open state by setting the RL1 pin to low logic level.

  err_t relay5_set_relay1_open ( relay5_t *ctx );

• relay5_set_relay1_close This function sets the relay 1 to normally close state by setting the RL1 pin to high logic level.

  err_t relay5_set_relay1_close ( relay5_t *ctx );

• relay5_switch_relay1 This function switches the relay 1 state by toggling the RL1 pin logic level.

  err_t relay5_switch_relay1 ( relay5_t *ctx );

Application Init

Initializes the driver and logger.

void application_init ( void )
{
    log_cfg_t log_cfg;  
    relay5_cfg_t relay5_cfg;  

    LOG_MAP_USB_UART( log_cfg );
    log_init( &logger, &log_cfg );
    log_info( &logger, " Application Init " );
 
    // Click initialization.
    relay5_cfg_setup( &relay5_cfg );
    RELAY5_MAP_MIKROBUS( relay5_cfg, MIKROBUS_POSITION_RELAY5 );
    if ( I2C_MASTER_ERROR == relay5_init( &relay5, &relay5_cfg ) ) 
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }
    
    if ( RELAY5_ERROR == relay5_default_cfg ( &relay5 ) )
    {
        log_error( &logger, " Default configuration." );
        for ( ; ; );
    }
    
    log_info( &logger, " Application Task " );
}

Application Task

Switches all relays state every 5 seconds and displays the state on the USB UART.

void application_task ( void )
{
    relay5_set_relay1_open ( &relay5 );
    log_printf( &logger, " Relay 1 set to normally open state\r\n" );
    relay5_set_relay2_close ( &relay5 );
    log_printf( &logger, " Relay 2 set to normally close state\r\n" );
    relay5_set_relay3_open ( &relay5 );
    log_printf( &logger, " Relay 3 set to normally open state\r\n\n" );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
 
    relay5_set_relay1_close ( &relay5 );
    log_printf( &logger, " Relay 1 set to normally close state\r\n" );
    relay5_set_relay2_open ( &relay5 );
    log_printf( &logger, " Relay 2 set to normally open state\r\n" );
    relay5_set_relay3_close ( &relay5 );
    log_printf( &logger, " Relay 3 set to normally close state\r\n\n" );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
}

Application Output

This Click board can be interfaced and monitored in two ways:

• Application Output - Use the "Application Output" window in Debug mode for real-time data monitoring. Set it up properly by following this tutorial.
• UART Terminal - Monitor data via the UART Terminal using a USB to UART converter. For detailed instructions, check out this tutorial.

Additional Notes and Information

The complete application code and a ready-to-use project are available through the NECTO Studio Package Manager for direct installation in the NECTO Studio. The application code can also be found on the MIKROE GitHub account.

---